GetWindowRegion

GetWindowRegion
Header:	MacWindows.h		Carbon status:	Supported

Obtains a handle to a specific window region.

OSStatus GetWindowRegion (
    WindowRef window, 
    WindowRegionCode inRegionCode, 
     ioWinRgn
);

Parameter descriptions

window: A pointer to the window to be examined.
inRegionCode: A constant representing the window region whose handle you wish to obtain; see “Window Region Constants”.
ioWinRgn: On input, a handle to a region created by your application. On return, the handle is set to the specified window region.

function result: A result code.

DISCUSSION

The GetWindowRegion function produces a handle to a window definition function’s window region in response to a kWindowMsgGetRegion message. The visibility of the window is unimportant for GetWindowRegion to work correctly.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.